Ensure empty descriptions notes, inputs, outputs and links create an accurate YAML #720
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
sdwheeler
approved these changes
Mar 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
This pull request includes changes to improve the handling of empty values in YAML outputs and adds corresponding tests to ensure the correct formatting. The most important changes include updates to the
YamlWritermethods and the addition of new test cases.Improvements to YAML output handling:
src/YamlWriter/CommandHelpYamlWriter.cs: Modified theWriteInputsOutputsandWriteNotesmethods to handle empty values by adding explicit empty strings or arrays in the YAML output. [1] [2] [3]Addition of new test cases:
test/Pester/YamlFormatting.Tests.ps1: Added new test cases to verify that inputs, outputs, notes, and related links are correctly formatted as empty arrays or strings when they are empty.test/Pester/assets/New-EmptyCommand.md: Added a new markdown file to serve as a test asset for the new YAML formatting tests.PR Context
Fixes #710